docs(readme): Document automatic setup #15

nicojs · 2016-12-30T09:11:08Z

Document how to use the new automatic setup using the karmaConfigFile option.

philippw

Better wording suggestions

philippw · 2016-12-30T09:24:48Z

README.md

+
+## Peer dependencies
+
+The `stryker-karma-runner` is a pluggin for `stryker` to enable `karma` as a test runner. As such you should install the correct versions of the dependencies:


The stryker-karma-runner is a plugin for stryker to enable karma as a test runner. As such, you should make sure you have the correct versions of it's dependencies installed:

philippw · 2016-12-30T09:26:03Z

README.md

+
+## Warning
+
+The stryker-karma-runner is available from stryker v0.4.0 onward.


The stryker-karma-runner is available starting with Stryker 0.4.0.

I'll remove it entirely. Nobody should use stryker < 0.4 ;)

philippw · 2016-12-30T09:26:12Z

README.md

+
+## Install
+
+Install stryker-karma-runner from your project folder:


Install stryker-karma-runner locally within your project folder, like so:

philippw · 2016-12-30T09:27:39Z

README.md

+
+## Configuring
+
+You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. This readme describes how to do it via the config file.


This README describes how to do use the stryker.conf.js config file.

philippw · 2016-12-30T09:28:07Z

README.md

+
+You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. This readme describes how to do it via the config file.
+
+### Load the plugin


Loading the plugin

philippw · 2016-12-30T09:39:26Z

README.md

+*Note*: Whichever testFramework you use should also be reflected in the `testFramework` property of stryker itself. For example: `testFramework: 'mocha'`  
+
+Not all karma config can be overriden, as Stryker requires specific functionality from the testRunner to do its magic. 
+Karma config that *cannot* be overriden:


The following Karma config options cannot be overridden:

philippw · 2016-12-30T09:40:08Z

README.md

+Not all karma config can be overriden, as Stryker requires specific functionality from the testRunner to do its magic. 
+Karma config that *cannot* be overriden:
+
+* `files`: The karma-runner will fill this based on the `files` and `filesToMutate` configuration in the `stryker-conf.js` file.


files: The karma-runner will set this option based on the files and filesToMutate configuration in the stryker-conf.js file.

philippw · 2016-12-30T09:40:28Z

README.md

+Karma config that *cannot* be overriden:
+
+* `files`: The karma-runner will fill this based on the `files` and `filesToMutate` configuration in the `stryker-conf.js` file.
+* `coverageReporter`: This will be enabled for the initial test run, disabled for testing the mutants.


coverageReporter: This will be enabled for the initial test run but disabled for testing the mutants.

philippw · 2016-12-30T09:41:43Z

README.md

+
+### Debugging
+
+By default, karma logging will be swallowed. 


As we' re running karma in it's own process, its logging output will be consumed by us.

philippw · 2016-12-30T09:42:05Z

README.md

+### Debugging
+
+By default, karma logging will be swallowed. 
+Set log level to `trace` in `stryker.conf.js` to see all the karma output.


To avoid this, set the log level to trace in stryker.conf.js.

philippw · 2016-12-30T10:04:54Z

README.md


 ```bash
 npm i --save-dev stryker-karma-runner
 ```

 ## Peer dependencies

-The `stryker-karma-runner` is a pluggin for `stryker` to enable `karma` as a test runner. As such you should install the correct versions of the dependencies:
+The `stryker-karma-runner` is a pluggin for `stryker` to enable `karma` as a test runner. 


plugging -> plugin

philippw · 2016-12-30T10:05:09Z

README.md


 ```bash
 npm i --save-dev stryker-karma-runner
 ```

 ## Peer dependencies

-The `stryker-karma-runner` is a pluggin for `stryker` to enable `karma` as a test runner. As such you should install the correct versions of the dependencies:
+The `stryker-karma-runner` is a pluggin for `stryker` to enable `karma` as a test runner. 
+As such, you should make sure you have the correct versions of it's dependencies installed:


philippw · 2016-12-30T10:06:13Z

README.md

@@ -33,24 +30,25 @@ These are marked as `peerDependencies` of `stryker-karma-runner` so you get a wa

 ## Configuring

-You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. This readme describes how to do it via the config file.
+You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. 


You can either configure the karma test runner using the command line or by providing a the stryker.conf.js file.

philippw · 2016-12-30T10:06:42Z

README.md

@@ -33,24 +30,25 @@ These are marked as `peerDependencies` of `stryker-karma-runner` so you get a wa

 ## Configuring

-You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. This readme describes how to do it via the config file.
+You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. 
+This README describes how to do use the `stryker.conf.js` config file.


This README describes how to use the stryker.conf.js config file.

philippw · 2016-12-30T10:07:44Z

README.md


 ### Load the plugin

 In order to use the `stryker-karma-runner` it must me loaded in the stryker mutation testing framework via the stryker configuration. 
-Easiest is to *leave out* the `plugins` section from your config entirely. That way, all node_modules starting with `stryker-` will be loaded.
+Easiest is to *not have a `plugins` section* from your config file. That way, all node_modules starting with `stryker-` will be loaded.


The easiest way to achieve this, is not have a plugins section in your config file. That way, all node_modules starting with stryker- will be loaded.

philippw · 2016-12-30T10:09:25Z

README.md


 * Karma's `files` option will be used to configure the files in Stryker, you don't need to keep a list of files in sync in both `stryker.conf.js` and `karma.conf.js`.
 * Karma's `exclude` option will be used to ignore files in Stryker (using `!` to ignore them)
-* Other karma config will be copied to the `karmaConfig` option in stryker config. These will be used by the `stryker-karma-runner` during mutation testing.
+* Other karma config will be copied to the `karmaConfig` option in Stryker config. They will be picked up by the `stryker-karma-runner` during mutation testing.


All remaining karma configs will be ...

philippw · 2016-12-30T10:11:29Z

README.md

+The following Karma config options cannot be overridden:
+
+* `files`: The karma-runner will fill this based on the `files` and `mutate` configuration in the `stryker-conf.js` file (or your `karma.conf.js` file when using the *automatic setup*).
+* `coverageReporter`: Stryker-karma-runner will use its own coverage reporter for the initial test run and disabled it for testing the mutants.


coverageReporter: For the initial test run, the stryker-karma-runner will use its own coverage reporter. For testing the mutants, however, it will be disabled.

philippw · 2016-12-30T10:12:03Z

README.md

@@ -152,8 +152,9 @@ See [http://stryker-mutator.github.io](http://stryker-mutator.github.io) for mor

 ### Debugging

-By default, karma logging will be swallowed. 
-Set log level to `trace` in `stryker.conf.js` to see all the karma output.
+As Stryker runs karma in it's own process, it's logging output will be consumed Stryker.


[...] will be consumed by Stryker.[...]

philippw

Added some more nitpicks

simondel · 2016-12-30T10:48:26Z

I'll implement your review @philippw, thanks!

nicojs added 2 commits December 30, 2016 10:09

chore(package.json): Add npm start script

3dd02bd

docs(readme): Document automatic setup

82269a5

nicojs requested a review from philippw December 30, 2016 09:11

philippw reviewed Dec 30, 2016

View reviewed changes

docs(readme): Minor typo's and fixes

8e8dd97

philippw reviewed Dec 30, 2016

View reviewed changes

fix(README): Improve wording and grammar

971ba83

simondel merged commit 3141e4d into master Dec 30, 2016

simondel deleted the docs-automatic-setup branch December 30, 2016 11:04

simondel mentioned this pull request Dec 30, 2016

Make use of karma.conf file #7

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(readme): Document automatic setup #15

docs(readme): Document automatic setup #15

nicojs commented Dec 30, 2016

philippw left a comment

philippw Dec 30, 2016

philippw Dec 30, 2016

nicojs Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016 •

edited

Loading

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw Dec 30, 2016

philippw left a comment

simondel commented Dec 30, 2016


		## Peer dependencies

		The `stryker-karma-runner` is a pluggin for `stryker` to enable `karma` as a test runner. As such you should install the correct versions of the dependencies:


		## Warning

		The stryker-karma-runner is available from stryker v0.4.0 onward.


		## Install

		Install stryker-karma-runner from your project folder:


		## Configuring

		You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. This readme describes how to do it via the config file.


		You can either configure the karma test runner from the `stryker.conf.js` file or from the command line. This readme describes how to do it via the config file.

		### Load the plugin

docs(readme): Document automatic setup #15

docs(readme): Document automatic setup #15

Conversation

nicojs commented Dec 30, 2016

philippw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philippw Dec 30, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philippw left a comment

Choose a reason for hiding this comment

simondel commented Dec 30, 2016

philippw Dec 30, 2016 •

edited

Loading